<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT>    package org.codemonkey.javareflection;<a name="line.1"></a>
<FONT color="green">002</FONT>    <a name="line.2"></a>
<FONT color="green">003</FONT>    import java.lang.reflect.Field;<a name="line.3"></a>
<FONT color="green">004</FONT>    import java.lang.reflect.Method;<a name="line.4"></a>
<FONT color="green">005</FONT>    import java.lang.reflect.Modifier;<a name="line.5"></a>
<FONT color="green">006</FONT>    import java.util.Arrays;<a name="line.6"></a>
<FONT color="green">007</FONT>    import java.util.EnumSet;<a name="line.7"></a>
<FONT color="green">008</FONT>    import java.util.HashMap;<a name="line.8"></a>
<FONT color="green">009</FONT>    import java.util.LinkedList;<a name="line.9"></a>
<FONT color="green">010</FONT>    import java.util.List;<a name="line.10"></a>
<FONT color="green">011</FONT>    import java.util.Map;<a name="line.11"></a>
<FONT color="green">012</FONT>    <a name="line.12"></a>
<FONT color="green">013</FONT>    import org.apache.commons.lang.StringUtils;<a name="line.13"></a>
<FONT color="green">014</FONT>    <a name="line.14"></a>
<FONT color="green">015</FONT>    /**<a name="line.15"></a>
<FONT color="green">016</FONT>     * A {@link Field} shorthand utility class mainly used to collect fields from classes meeting certain restrictions/requirements.<a name="line.16"></a>
<FONT color="green">017</FONT>     * &lt;p&gt;<a name="line.17"></a>
<FONT color="green">018</FONT>     * With this utility class you can perform field lookups, by combining lookup restriction criteria. A trivial example is find all fields on<a name="line.18"></a>
<FONT color="green">019</FONT>     * a class &lt;em&gt;Apple&lt;/em&gt;, not looking at its super classes, which should be protected, have a getter method, but not a setter method:<a name="line.19"></a>
<FONT color="green">020</FONT>     * <a name="line.20"></a>
<FONT color="green">021</FONT>     * &lt;pre&gt;<a name="line.21"></a>
<FONT color="green">022</FONT>     * FieldUtils.collectFields(Apple.class, Apple.class, EnumSet.of(Visibility.PROTECTED),<a name="line.22"></a>
<FONT color="green">023</FONT>     *              EnumSet.of(BeanRestriction.YES_GETTER, BeanRestriction.NO_SETTER));<a name="line.23"></a>
<FONT color="green">024</FONT>     * &lt;/pre&gt;<a name="line.24"></a>
<FONT color="green">025</FONT>     * <a name="line.25"></a>
<FONT color="green">026</FONT>     * @author Benny Bottema<a name="line.26"></a>
<FONT color="green">027</FONT>     * @see #collectFields(Class, Class, EnumSet, EnumSet)<a name="line.27"></a>
<FONT color="green">028</FONT>     */<a name="line.28"></a>
<FONT color="green">029</FONT>    public final class FieldUtils {<a name="line.29"></a>
<FONT color="green">030</FONT>            private FieldUtils() {<a name="line.30"></a>
<FONT color="green">031</FONT>            }<a name="line.31"></a>
<FONT color="green">032</FONT>    <a name="line.32"></a>
<FONT color="green">033</FONT>            /**<a name="line.33"></a>
<FONT color="green">034</FONT>             * Determines what visibility modifiers a field is allowed to have in {@link FieldUtils#collectFields(Class, Class, EnumSet, EnumSet)}.<a name="line.34"></a>
<FONT color="green">035</FONT>             * <a name="line.35"></a>
<FONT color="green">036</FONT>             * @author Benny Bottema<a name="line.36"></a>
<FONT color="green">037</FONT>             */<a name="line.37"></a>
<FONT color="green">038</FONT>            public enum Visibility {<a name="line.38"></a>
<FONT color="green">039</FONT>                    /**<a name="line.39"></a>
<FONT color="green">040</FONT>                     * Visibility flag that corresponds with java's keyword &lt;code&gt;private&lt;/code&gt;.<a name="line.40"></a>
<FONT color="green">041</FONT>                     */<a name="line.41"></a>
<FONT color="green">042</FONT>                    PRIVATE(Modifier.PRIVATE),<a name="line.42"></a>
<FONT color="green">043</FONT>                    /**<a name="line.43"></a>
<FONT color="green">044</FONT>                     * Visibility flag that corresponds with java's visibility modifier &lt;code&gt;default&lt;/code&gt; (package protected).<a name="line.44"></a>
<FONT color="green">045</FONT>                     */<a name="line.45"></a>
<FONT color="green">046</FONT>                    DEFAULT(-1), // no Java equivalent<a name="line.46"></a>
<FONT color="green">047</FONT>                    /**<a name="line.47"></a>
<FONT color="green">048</FONT>                     * Visibility flag that corresponds with java's keyword &lt;code&gt;protected&lt;/code&gt;.<a name="line.48"></a>
<FONT color="green">049</FONT>                     */<a name="line.49"></a>
<FONT color="green">050</FONT>                    PROTECTED(Modifier.PROTECTED),<a name="line.50"></a>
<FONT color="green">051</FONT>                    /**<a name="line.51"></a>
<FONT color="green">052</FONT>                     * Visibility flag that corresponds with java's keyword &lt;code&gt;public&lt;/code&gt;.<a name="line.52"></a>
<FONT color="green">053</FONT>                     */<a name="line.53"></a>
<FONT color="green">054</FONT>                    PUBLIC(Modifier.PUBLIC);<a name="line.54"></a>
<FONT color="green">055</FONT>                    private int modifierFlag;<a name="line.55"></a>
<FONT color="green">056</FONT>    <a name="line.56"></a>
<FONT color="green">057</FONT>                    private Visibility(final int modifierFlag) {<a name="line.57"></a>
<FONT color="green">058</FONT>                            this.modifierFlag = modifierFlag;<a name="line.58"></a>
<FONT color="green">059</FONT>                    }<a name="line.59"></a>
<FONT color="green">060</FONT>            }<a name="line.60"></a>
<FONT color="green">061</FONT>    <a name="line.61"></a>
<FONT color="green">062</FONT>            /**<a name="line.62"></a>
<FONT color="green">063</FONT>             * Indicates whether a field needs a Bean setter or getter, exactly none or any combination thereof. Determines what kind of fields are<a name="line.63"></a>
<FONT color="green">064</FONT>             * potential collection candidates.<a name="line.64"></a>
<FONT color="green">065</FONT>             * <a name="line.65"></a>
<FONT color="green">066</FONT>             * @author Benny Bottema<a name="line.66"></a>
<FONT color="green">067</FONT>             */<a name="line.67"></a>
<FONT color="green">068</FONT>            public enum BeanRestriction {<a name="line.68"></a>
<FONT color="green">069</FONT>                    /**<a name="line.69"></a>
<FONT color="green">070</FONT>                     * Restriction flag that indicates a &lt;em&gt;getter&lt;/em&gt; method is required.<a name="line.70"></a>
<FONT color="green">071</FONT>                     */<a name="line.71"></a>
<FONT color="green">072</FONT>                    YES_GETTER,<a name="line.72"></a>
<FONT color="green">073</FONT>                    /**<a name="line.73"></a>
<FONT color="green">074</FONT>                     * Restriction flag that indicates a &lt;em&gt;setter&lt;/em&gt; method is required.<a name="line.74"></a>
<FONT color="green">075</FONT>                     */<a name="line.75"></a>
<FONT color="green">076</FONT>                    YES_SETTER,<a name="line.76"></a>
<FONT color="green">077</FONT>                    /**<a name="line.77"></a>
<FONT color="green">078</FONT>                     * Restriction flag that indicates no &lt;em&gt;setter&lt;/em&gt; must be available.<a name="line.78"></a>
<FONT color="green">079</FONT>                     */<a name="line.79"></a>
<FONT color="green">080</FONT>                    NO_SETTER,<a name="line.80"></a>
<FONT color="green">081</FONT>                    /**<a name="line.81"></a>
<FONT color="green">082</FONT>                     * Restriction flag that indicates a &lt;em&gt;getter&lt;/em&gt; must be available.<a name="line.82"></a>
<FONT color="green">083</FONT>                     */<a name="line.83"></a>
<FONT color="green">084</FONT>                    NO_GETTER;<a name="line.84"></a>
<FONT color="green">085</FONT>            }<a name="line.85"></a>
<FONT color="green">086</FONT>    <a name="line.86"></a>
<FONT color="green">087</FONT>            /**<a name="line.87"></a>
<FONT color="green">088</FONT>             * Returns a pool of {@link Field} wrappers including optional relevant setter/getter methods, collected from the given class tested<a name="line.88"></a>
<FONT color="green">089</FONT>             * against the given visibility and Bean restriction requirements.<a name="line.89"></a>
<FONT color="green">090</FONT>             * &lt;p&gt;<a name="line.90"></a>
<FONT color="green">091</FONT>             * The returned fields are mapped against the classes they were found on, since field names can be declared multiple times with the same<a name="line.91"></a>
<FONT color="green">092</FONT>             * name.<a name="line.92"></a>
<FONT color="green">093</FONT>             * <a name="line.93"></a>
<FONT color="green">094</FONT>             * @param _class The class (and chain) to harvest fields from.<a name="line.94"></a>
<FONT color="green">095</FONT>             * @param boundaryMarker The last &lt;code&gt;class&gt;&lt;/code&gt; or &lt;code&gt;interface&lt;/code&gt; implementing class that fields are collected from. Can<a name="line.95"></a>
<FONT color="green">096</FONT>             *            be used to prevent finding fields on a supper class.<a name="line.96"></a>
<FONT color="green">097</FONT>             * @param visibility A set of visibility requirements (ie. {@link Visibility#PROTECTED} indicates a field is allowed to have<a name="line.97"></a>
<FONT color="green">098</FONT>             *            &lt;code&gt;protected&lt;/code&gt; visibility).<a name="line.98"></a>
<FONT color="green">099</FONT>             * @param beanRestrictions A set of Bean restriction requirements indicating a field should or shouldn't have a setter, getter or both.<a name="line.99"></a>
<FONT color="green">100</FONT>             * @return A Map per class in the chain with the fields declared by that class.<a name="line.100"></a>
<FONT color="green">101</FONT>             * @see #meetsVisibilityRequirements(Field, EnumSet)<a name="line.101"></a>
<FONT color="green">102</FONT>             * @see #resolveBeanProperty(Field, EnumSet)<a name="line.102"></a>
<FONT color="green">103</FONT>             */<a name="line.103"></a>
<FONT color="green">104</FONT>            public static Map&lt;Class&lt;?&gt;, List&lt;FieldWrapper&gt;&gt; collectFields(final Class&lt;?&gt; _class, final Class&lt;?&gt; boundaryMarker,<a name="line.104"></a>
<FONT color="green">105</FONT>                            final EnumSet&lt;Visibility&gt; visibility, final EnumSet&lt;BeanRestriction&gt; beanRestrictions) {<a name="line.105"></a>
<FONT color="green">106</FONT>                    final Map&lt;Class&lt;?&gt;, List&lt;FieldWrapper&gt;&gt; fields = new HashMap&lt;Class&lt;?&gt;, List&lt;FieldWrapper&gt;&gt;();<a name="line.106"></a>
<FONT color="green">107</FONT>                    final Field[] allFields = _class.getDeclaredFields();<a name="line.107"></a>
<FONT color="green">108</FONT>                    final List&lt;FieldWrapper&gt; filteredFields = new LinkedList&lt;FieldWrapper&gt;();<a name="line.108"></a>
<FONT color="green">109</FONT>                    for (final Field field : allFields) {<a name="line.109"></a>
<FONT color="green">110</FONT>                            if (meetsVisibilityRequirements(field, visibility)) {<a name="line.110"></a>
<FONT color="green">111</FONT>                                    final FieldWrapper property = resolveBeanProperty(field, beanRestrictions);<a name="line.111"></a>
<FONT color="green">112</FONT>                                    if (property != null) {<a name="line.112"></a>
<FONT color="green">113</FONT>                                            filteredFields.add(property);<a name="line.113"></a>
<FONT color="green">114</FONT>                                    }<a name="line.114"></a>
<FONT color="green">115</FONT>                            }<a name="line.115"></a>
<FONT color="green">116</FONT>                            fields.put(_class, filteredFields);<a name="line.116"></a>
<FONT color="green">117</FONT>                    }<a name="line.117"></a>
<FONT color="green">118</FONT>                    // determine if we need to look deeper<a name="line.118"></a>
<FONT color="green">119</FONT>                    final List&lt;Class&lt;?&gt;&gt; interfaces = Arrays.asList(_class.getInterfaces());<a name="line.119"></a>
<FONT color="green">120</FONT>                    if (_class.equals(boundaryMarker) || interfaces.contains(boundaryMarker)) {<a name="line.120"></a>
<FONT color="green">121</FONT>                            return fields;<a name="line.121"></a>
<FONT color="green">122</FONT>                    } else {<a name="line.122"></a>
<FONT color="green">123</FONT>                            fields.putAll(collectFields(_class.getSuperclass(), boundaryMarker, visibility, beanRestrictions));<a name="line.123"></a>
<FONT color="green">124</FONT>                            return fields;<a name="line.124"></a>
<FONT color="green">125</FONT>                    }<a name="line.125"></a>
<FONT color="green">126</FONT>            }<a name="line.126"></a>
<FONT color="green">127</FONT>    <a name="line.127"></a>
<FONT color="green">128</FONT>            /**<a name="line.128"></a>
<FONT color="green">129</FONT>             * Determines if the visibility modifiers of a given {@link Field} is included in the set of flags.<a name="line.129"></a>
<FONT color="green">130</FONT>             * <a name="line.130"></a>
<FONT color="green">131</FONT>             * @param field The field who's visibility modifiers we want to test.<a name="line.131"></a>
<FONT color="green">132</FONT>             * @param visibility List of {@link Visibility} flags to test against.<a name="line.132"></a>
<FONT color="green">133</FONT>             * @return Whether a given field has one of the specified visibility flags.<a name="line.133"></a>
<FONT color="green">134</FONT>             */<a name="line.134"></a>
<FONT color="green">135</FONT>            static boolean meetsVisibilityRequirements(final Field field, final EnumSet&lt;Visibility&gt; visibility) {<a name="line.135"></a>
<FONT color="green">136</FONT>                    for (final Visibility visibilityModifier : visibility) {<a name="line.136"></a>
<FONT color="green">137</FONT>                            final int m = field.getModifiers();<a name="line.137"></a>
<FONT color="green">138</FONT>                            if (!visibilityModifier.equals(Visibility.DEFAULT)) {<a name="line.138"></a>
<FONT color="green">139</FONT>                                    if ((m &amp; visibilityModifier.modifierFlag) != 0) {<a name="line.139"></a>
<FONT color="green">140</FONT>                                            return true;<a name="line.140"></a>
<FONT color="green">141</FONT>                                    }<a name="line.141"></a>
<FONT color="green">142</FONT>                            } else {<a name="line.142"></a>
<FONT color="green">143</FONT>                                    if (!Modifier.isPrivate(m) &amp;&amp; !Modifier.isProtected(m) &amp;&amp; !Modifier.isPublic(m)) {<a name="line.143"></a>
<FONT color="green">144</FONT>                                            return true;<a name="line.144"></a>
<FONT color="green">145</FONT>                                    }<a name="line.145"></a>
<FONT color="green">146</FONT>                            }<a name="line.146"></a>
<FONT color="green">147</FONT>                    }<a name="line.147"></a>
<FONT color="green">148</FONT>                    return false;<a name="line.148"></a>
<FONT color="green">149</FONT>            }<a name="line.149"></a>
<FONT color="green">150</FONT>    <a name="line.150"></a>
<FONT color="green">151</FONT>            /**<a name="line.151"></a>
<FONT color="green">152</FONT>             * Determines if a given &lt;code&gt;Field&lt;/code&gt; meets the specified Bean restriction requirements and returns the field as a BeanProperty<a name="line.152"></a>
<FONT color="green">153</FONT>             * with optional getter/setter.<a name="line.153"></a>
<FONT color="green">154</FONT>             * <a name="line.154"></a>
<FONT color="green">155</FONT>             * @param field The field to test.<a name="line.155"></a>
<FONT color="green">156</FONT>             * @param beanRestrictions The Bean restrictions to apply (should/shouldn't have setter/getter).<a name="line.156"></a>
<FONT color="green">157</FONT>             * @return Whether the field fits the restrictions.<a name="line.157"></a>
<FONT color="green">158</FONT>             */<a name="line.158"></a>
<FONT color="green">159</FONT>            static FieldWrapper resolveBeanProperty(final Field field, final EnumSet&lt;BeanRestriction&gt; beanRestrictions) {<a name="line.159"></a>
<FONT color="green">160</FONT>                    if (beanRestrictions.containsAll(EnumSet.of(BeanRestriction.NO_GETTER, BeanRestriction.YES_GETTER)) //<a name="line.160"></a>
<FONT color="green">161</FONT>                                    || beanRestrictions.containsAll(EnumSet.of(BeanRestriction.NO_SETTER, BeanRestriction.YES_SETTER))) {<a name="line.161"></a>
<FONT color="green">162</FONT>                            throw new IllegalArgumentException("cannot both include and exclude a setter/getter requirement");<a name="line.162"></a>
<FONT color="green">163</FONT>                    }<a name="line.163"></a>
<FONT color="green">164</FONT>    <a name="line.164"></a>
<FONT color="green">165</FONT>                    // since PropertyUtilsBean#getPropertyDescriptors(...) doesn't detect setters without getters (Bean convention)<a name="line.165"></a>
<FONT color="green">166</FONT>                    // we'll just find setter/getters manually<a name="line.166"></a>
<FONT color="green">167</FONT>                    final String setterName = "set" + StringUtils.capitalize(field.getName());<a name="line.167"></a>
<FONT color="green">168</FONT>                    final String getterName;<a name="line.168"></a>
<FONT color="green">169</FONT>                    if (field.getType().equals(boolean.class)) {<a name="line.169"></a>
<FONT color="green">170</FONT>                            getterName = "is" + StringUtils.capitalize(field.getName());<a name="line.170"></a>
<FONT color="green">171</FONT>                    } else {<a name="line.171"></a>
<FONT color="green">172</FONT>                            getterName = "get" + StringUtils.capitalize(field.getName());<a name="line.172"></a>
<FONT color="green">173</FONT>                    }<a name="line.173"></a>
<FONT color="green">174</FONT>                    final Method writeMethod = JReflect.findSimpleCompatibleMethod(field.getDeclaringClass(), setterName, field.getType());<a name="line.174"></a>
<FONT color="green">175</FONT>                    final Method readMethod = JReflect.findSimpleCompatibleMethod(field.getDeclaringClass(), getterName);<a name="line.175"></a>
<FONT color="green">176</FONT>    <a name="line.176"></a>
<FONT color="green">177</FONT>                    if (!((readMethod != null &amp;&amp; beanRestrictions.contains(BeanRestriction.NO_GETTER)) //<a name="line.177"></a>
<FONT color="green">178</FONT>                                    || (!(readMethod != null) &amp;&amp; beanRestrictions.contains(BeanRestriction.YES_GETTER)) //<a name="line.178"></a>
<FONT color="green">179</FONT>                                    || (writeMethod != null &amp;&amp; beanRestrictions.contains(BeanRestriction.NO_SETTER)) //<a name="line.179"></a>
<FONT color="green">180</FONT>                    || (!(writeMethod != null) &amp;&amp; beanRestrictions.contains(BeanRestriction.YES_SETTER)))) {<a name="line.180"></a>
<FONT color="green">181</FONT>                            return new FieldWrapper(field, readMethod, writeMethod);<a name="line.181"></a>
<FONT color="green">182</FONT>                    } else {<a name="line.182"></a>
<FONT color="green">183</FONT>                            return null;<a name="line.183"></a>
<FONT color="green">184</FONT>                    }<a name="line.184"></a>
<FONT color="green">185</FONT>            }<a name="line.185"></a>
<FONT color="green">186</FONT>    }<a name="line.186"></a>




























































</PRE>
</BODY>
</HTML>
